STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

D.9.1 StructureDefinition: DAF-Immunization

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/daf-immunization

Defines constraints and extensions on the Immunization resource for use in querying and retrieving patient's immunization information.

This profile was published on Thu, Aug 21, 2014 00:00+1000 as a draft by Health Level Seven International (Infrastructure and Messaging - Data Access Framework).

D.9.1.1 Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Immunization.

Summary

Mandatory: 5 elements (+3 nested mandatory elements)
Must-Support: 29 elements

Structures

This structure refers to these other structures:

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization I0..*ImmunizationImmunization event information
imm-2: If immunization was administered (wasNotGiven=false) then explanation.reasonNotGiven SHALL be absent.
imm-1: If immunization was not administered (wasNotGiven=true) then there SHALL be no reaction nor explanation.reason present
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S0..*IdentifierBusiness identifier
... status ?! S∑1..1codein-progress | on-hold | completed | entered-in-error | stopped
Binding: MedicationAdministrationStatus (required)
... date S1..1dateTimeVaccination administration date
... vaccineCode S1..1CodeableConceptVaccine Product Type (bind to CVX)
Binding: Vaccine Administered Value Set (preferred)
... patient S1..1Reference(DAF-Patient)Who was immunized
... wasNotGiven ?!1..1booleanFlag for whether immunization was given
... reported S1..1booleanIndicates a self-reported record
... performer S0..1Reference(DAF-Pract | DAF-Organization)Who administered vaccine
... requester S0..1Reference(DAF-Pract | DAF-Organization)Who ordered vaccination
... encounter 0..1Reference(DAF-Encounter)Encounter administered as part of
... manufacturer S0..1Reference(DAF-Organization)Vaccine Manufacturer
... location 0..1Reference(Location)Where vaccination occurred
... lotNumber S0..1stringVaccine lot number
... expirationDate S0..1dateVaccine expiration date
... site S0..1CodeableConceptBody site vaccine was administered
Binding: Vaccine Administered Body Site (preferred)
... route S0..1CodeableConceptHow vaccine entered body
Binding: Medication Route FDA Value Set (preferred)
... doseQuantity S I0..1SimpleQuantityAmount of vaccine administered
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
... note ∑0..*AnnotationVaccination notes
... explanation S0..1BackboneElementAdministration/non-administration reasons
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... reason S0..*CodeableConceptWhy immunization occurred
Binding: Immunization Reason Codes (example)
.... reasonNotGiven S0..*CodeableConceptWhy immunization did not occur
Binding: Immunization Reasons for Not Immunizing Codes (example)
... reaction S0..*BackboneElementDetails of a reaction that follows immunization
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... date S0..1dateTimeWhen reaction started
.... detail 0..1Reference(Observation)Additional information on reaction
.... reported S0..1booleanIndicates self-reported reaction
... vaccinationProtocol S0..*BackboneElementWhat protocol was followed
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... doseSequence S1..1positiveIntDose number within series
.... description S0..1stringDetails of vaccine protocol
.... authority S0..1Reference(DAF-Organization)Who is responsible for protocol
.... series S0..1stringName of vaccine series
.... seriesDoses S0..1positiveIntRecommended number of doses for immunity
.... targetDisease S1..1CodeableConceptDisease immunized against
Binding: Vaccination Protocol Dose Target Codes (example)
.... doseStatus S1..1CodeableConceptIndicates if dose counts towards immunity
Binding: Vaccination Protocol Dose Status codes (example)
.... doseStatusReason S0..1CodeableConceptWhy dose does (not) count
Binding: Vaccination Protocol Dose Status Reason codes (example)

doco Documentation for this format

todo

This structure is derived from Immunization.

Summary

Mandatory: 5 elements (+3 nested mandatory elements)
Must-Support: 29 elements

Structures

This structure refers to these other structures:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization I0..*ImmunizationImmunization event information
imm-2: If immunization was administered (wasNotGiven=false) then explanation.reasonNotGiven SHALL be absent.
imm-1: If immunization was not administered (wasNotGiven=true) then there SHALL be no reaction nor explanation.reason present
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S0..*IdentifierBusiness identifier
... status ?! S∑1..1codein-progress | on-hold | completed | entered-in-error | stopped
Binding: MedicationAdministrationStatus (required)
... date S1..1dateTimeVaccination administration date
... vaccineCode S1..1CodeableConceptVaccine Product Type (bind to CVX)
Binding: Vaccine Administered Value Set (preferred)
... patient S1..1Reference(DAF-Patient)Who was immunized
... wasNotGiven ?!1..1booleanFlag for whether immunization was given
... reported S1..1booleanIndicates a self-reported record
... performer S0..1Reference(DAF-Pract | DAF-Organization)Who administered vaccine
... requester S0..1Reference(DAF-Pract | DAF-Organization)Who ordered vaccination
... encounter 0..1Reference(DAF-Encounter)Encounter administered as part of
... manufacturer S0..1Reference(DAF-Organization)Vaccine Manufacturer
... location 0..1Reference(Location)Where vaccination occurred
... lotNumber S0..1stringVaccine lot number
... expirationDate S0..1dateVaccine expiration date
... site S0..1CodeableConceptBody site vaccine was administered
Binding: Vaccine Administered Body Site (preferred)
... route S0..1CodeableConceptHow vaccine entered body
Binding: Medication Route FDA Value Set (preferred)
... doseQuantity S I0..1SimpleQuantityAmount of vaccine administered
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
... note ∑0..*AnnotationVaccination notes
... explanation S0..1BackboneElementAdministration/non-administration reasons
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... reason S0..*CodeableConceptWhy immunization occurred
Binding: Immunization Reason Codes (example)
.... reasonNotGiven S0..*CodeableConceptWhy immunization did not occur
Binding: Immunization Reasons for Not Immunizing Codes (example)
... reaction S0..*BackboneElementDetails of a reaction that follows immunization
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... date S0..1dateTimeWhen reaction started
.... detail 0..1Reference(Observation)Additional information on reaction
.... reported S0..1booleanIndicates self-reported reaction
... vaccinationProtocol S0..*BackboneElementWhat protocol was followed
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... doseSequence S1..1positiveIntDose number within series
.... description S0..1stringDetails of vaccine protocol
.... authority S0..1Reference(DAF-Organization)Who is responsible for protocol
.... series S0..1stringName of vaccine series
.... seriesDoses S0..1positiveIntRecommended number of doses for immunity
.... targetDisease S1..1CodeableConceptDisease immunized against
Binding: Vaccination Protocol Dose Target Codes (example)
.... doseStatus S1..1CodeableConceptIndicates if dose counts towards immunity
Binding: Vaccination Protocol Dose Status codes (example)
.... doseStatusReason S0..1CodeableConceptWhy dose does (not) count
Binding: Vaccination Protocol Dose Status Reason codes (example)

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

D.9.1.2 Terminology Bindings

PathNameConformanceValueSet
Immunization.language?extrequiredhttp://tools.ietf.org/html/bcp47
Immunization.statusMedicationAdministrationStatusrequiredMedicationAdministrationStatus
Immunization.vaccineCodeVaccine Administered Value SetpreferredVaccine Administered Value Set
Immunization.siteVaccine Administered Body SitepreferredVaccine Administered Body Site
Immunization.routeMedication Route FDA Value SetpreferredMedication Route FDA Value Set
Immunization.explanation.reasonImmunization Reason CodesexampleImmunization Reason Codes
Immunization.explanation.reasonNotGivenImmunization Reasons for Not Immunizing CodesexampleImmunization Reasons for Not Immunizing Codes
Immunization.vaccinationProtocol.targetDiseaseVaccination Protocol Dose Target CodesexampleVaccination Protocol Dose Target Codes
Immunization.vaccinationProtocol.doseStatusVaccination Protocol Dose Status codesexampleVaccination Protocol Dose Status codes
Immunization.vaccinationProtocol.doseStatusReasonVaccination Protocol Dose Status Reason codesexampleVaccination Protocol Dose Status Reason codes

D.9.1.3 Constraints

IdPathDetailsRequirements
imm-2ImmunizationIf immunization was administered (wasNotGiven=false) then explanation.reasonNotGiven SHALL be absent.
XPath: not(f:wasNotGiven/@value=false() and exists(f:explanation/f:reasonNotGiven))
imm-1ImmunizationIf immunization was not administered (wasNotGiven=true) then there SHALL be no reaction nor explanation.reason present
XPath: not(f:wasNotGiven/@value=true() and (count(f:reaction) > 0 or exists(f:explanation/f:reason)))
qty-3Immunization.doseQuantityIf a code for the unit is present, the system SHALL also be present
XPath: not(exists(f:code)) or exists(f:system)
sqty-1Immunization.doseQuantityThe comparator is not used on a SimpleQuantity
XPath: not(exists(f:comparator))
.